<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Plurious Framework » \plurious\modules\login\Login</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Plurious Framework</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/framework.html"><i class="icon-th"></i> framework</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a href="../namespaces/plurious.html"><i class="icon-th"></i> plurious</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">439</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">82</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public inherited"><a href="#__construct" title="__construct :: Sets up primary objects as a convenience for the page controllers
that extend this class"><span class="description">Sets up primary objects as a convenience for the page controllers
that extend this class</span><pre>__construct()</pre></a></li>
<li class="method public inherited"><a href="#get" title="get :: Convenience method for the use by controllers"><span class="description">Convenience method for the use by controllers</span><pre>get()</pre></a></li>
<li class="method public inherited"><a href="#getElement" title="getElement :: Convenience method for the use by controllers"><span class="description">Convenience method for the use by controllers</span><pre>getElement()</pre></a></li>
<li class="method public inherited"><a href="#getLanguage" title="getLanguage :: Loads a new language file"><span class="description">Loads a new language file</span><pre>getLanguage()</pre></a></li>
<li class="method public inherited"><a href="#getText" title="getText :: Retrieves the language idiom for a given key"><span class="description">Retrieves the language idiom for a given key</span><pre>getText()</pre></a></li>
<li class="method public "><a href="#index" title="index :: "><span class="description">index()
        </span><pre>index()</pre></a></li>
<li class="method public inherited"><a href="#set" title="set :: Convenience method for the use by controllers"><span class="description">Convenience method for the use by controllers</span><pre>set()</pre></a></li>
<li class="method public inherited"><a href="#setElement" title="setElement :: Convenience method for the use by controllers"><span class="description">Convenience method for the use by controllers</span><pre>setElement()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#addChild" title="addChild :: Adds a child controller to the list of controllers to execute"><span class="description">Adds a child controller to the list of controllers to execute</span><pre>addChild()</pre></a></li>
<li class="method protected inherited"><a href="#addChildren" title="addChildren :: Adds children controllers listed in the controller method being executed"><span class="description">Adds children controllers listed in the controller method being executed</span><pre>addChildren()</pre></a></li>
<li class="method protected inherited"><a href="#addModules" title="addModules :: Adds modules listed in the controller method being executed"><span class="description">Adds modules listed in the controller method being executed</span><pre>addModules()</pre></a></li>
<li class="method protected inherited"><a href="#forward" title="forward :: Internal forwarding to another main action without redirecting client"><span class="description">Internal forwarding to another main action without redirecting client</span><pre>forward()</pre></a></li>
<li class="method protected inherited"><a href="#redirect" title="redirect :: Convenience method for redirecting from within controllers"><span class="description">Convenience method for redirecting from within controllers</span><pre>redirect()</pre></a></li>
<li class="method protected inherited"><a href="#render" title="render :: Recursive function is called repeatedly to construct output."><span class="description">Recursive function is called repeatedly to construct output.</span><pre>render()</pre></a></li>
<li class="method protected inherited"><a href="#setTemplate" title="setTemplate :: Allows template swapping from inside the page Controller object"><span class="description">Allows template swapping from inside the page Controller object</span><pre>setTemplate()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private inherited"><a href="#consolidateData" title="consolidateData :: Combines all child controller and module output"><span class="description">Combines all child controller and module output</span><pre>consolidateData()</pre></a></li>
<li class="method private inherited"><a href="#init" title="init :: Sets the base language"><span class="description">Sets the base language</span><pre>init()</pre></a></li>
<li class="method private inherited"><a href="#isCached" title="isCached :: Checks to see if a cached file should be returned, finds it and sets
output content from the cache."><span class="description">Checks to see if a cached file should be returned, finds it and sets
output content from the cache.</span><pre>isCached()</pre></a></li>
<li class="method private "><a href="#setupLogin" title="setupLogin :: "><span class="description">setupLogin()
        </span><pre>setupLogin()</pre></a></li>
<li class="method private "><a href="#setupLogout" title="setupLogout :: "><span class="description">setupLogout()
        </span><pre>setupLogout()</pre></a></li>
<li class="method private inherited"><a href="#writeCache" title="writeCache :: Checks to see if the buffer outut should be cached and writes it if so"><span class="description">Checks to see if the buffer outut should be cached and writes it if so</span><pre>writeCache()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected inherited"><a href="#%24action" title="$action :: Makes the Actions object available to the page controllers"><span class="description">Makes the Actions object available to the page controllers</span><pre>$action</pre></a></li>
<li class="property protected inherited"><a href="#%24config" title="$config :: Makes the Config object available to the page controllers"><span class="description">Makes the Config object available to the page controllers</span><pre>$config</pre></a></li>
<li class="property protected inherited"><a href="#%24data" title="$data :: Holds page data that will be used by the view templates"><span class="description">Holds page data that will be used by the view templates</span><pre>$data</pre></a></li>
<li class="property protected inherited"><a href="#%24document" title="$document :: Makes the Docment object available to the page controllers"><span class="description">Makes the Docment object available to the page controllers</span><pre>$document</pre></a></li>
<li class="property protected "><a href="#%24isCachable" title="$isCachable :: "><span class="description">$isCachable</span><pre>$isCachable</pre></a></li>
<li class="property protected inherited"><a href="#%24registry" title="$registry :: Makes the Registry object available to the page controllers"><span class="description">Makes the Registry object available to the page controllers</span><pre>$registry</pre></a></li>
<li class="property protected inherited"><a href="#%24request" title="$request :: Makes the Request object available to the page controllers"><span class="description">Makes the Request object available to the page controllers</span><pre>$request</pre></a></li>
<li class="property protected inherited"><a href="#%24url" title="$url :: Makes the URL object available to the page controllers"><span class="description">Makes the URL object available to the page controllers</span><pre>$url</pre></a></li>
<li class="property protected inherited"><a href="#%24user" title="$user :: Makes the User object available to the page controllers"><span class="description">Makes the User object available to the page controllers</span><pre>$user</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="property private inherited"><a href="#%24cache" title="$cache :: Holds the Cache object for use within this controller"><span class="description">Holds the Cache object for use within this controller</span><pre>$cache</pre></a></li>
<li class="property private inherited"><a href="#%24directory" title="$directory :: "><span class="description">$directory</span><pre>$directory</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cplurious%5Cmodules%5Clogin%5CLogin" id="\plurious\modules\login\Login"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/plurious.html">plurious</a></li>
<span class="divider">\</span><li><a href="../namespaces/plurious.modules.html">modules</a></li>
<span class="divider">\</span><li><a href="../namespaces/plurious.modules.login.html">login</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/plurious.modules.login.Login.html">Login</a>
</li>
</ul>
<div href="../classes/plurious.modules.login.Login.html" class="element class">
<p class="short_description">Base controller provides convenience features for use by other controllers
that extend this controller.</p>
<div class="details">
<p class="long_description"><p>Provides language localization support</p></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:randy@plurious.com">Randy Casburn</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright Plurious Software, all rights reserved</td>
</tr>
<tr>
<th>version</th>
<td>2.1</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Sets up primary objects as a convenience for the page controllers
that extend this class</h2>
<pre>__construct() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::__construct()</td>
</tr></table>
</div></div>
</div>
<a name="get" id="get"></a><div class="element clickable method public get" data-toggle="collapse" data-target=".get .collapse">
<h2>Convenience method for the use by controllers</h2>
<pre>get(string $key) : mixed</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr>
<tr>
<th>see</th>
<td>\framework\engine\Registry::get()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::get()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code><p>retrieve the associated value</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>value associated with the key</div>
</div></div>
</div>
<a name="getElement" id="getElement"></a><div class="element clickable method public getElement" data-toggle="collapse" data-target=".getElement .collapse">
<h2>Convenience method for the use by controllers</h2>
<pre>getElement(string $key, string $value) : mixed</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr>
<tr>
<th>see</th>
<td>\framework\engine\Registry::getElement()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::getElement()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code><p>The key pointing to an array to search</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>string</code><p>The key of the array to search</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>value associated with the [key][value] multi-dimensional array</div>
</div></div>
</div>
<a name="getLanguage" id="getLanguage"></a><div class="element clickable method public getLanguage" data-toggle="collapse" data-target=".getLanguage .collapse">
<h2>Loads a new language file</h2>
<pre>getLanguage(\framework\library\type $filename) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Searches in the context language directory first, then the system
language directory, then the module specific language directory for the
language file to load.  If now found an error is triggered.</p>

<p>The method will search for the given language file in the follow order:
1. {context_dir}/language/{lang}/{$filename}.php  <br>
   (ie. web/language/en/english.php)
2. {SYSTEM_DIR}/language/{lang}/{$filename}.php  <br>
   (ie. plurious/language/en/english.php)
3. {SYSTEM_DIR}/modules/{$filename}/language/{lang}/{$filename}.php  <br>
   (ie. plurious/modules/googleTalk/language/en/googleTalk.php)</p></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\framework\library\Language::getLanguage()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::getLanguage()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$filename</h4>
<code>\framework\library\type</code><p>The filename of the file containing the localized idioms</p></div>
</div></div>
</div>
<a name="getText" id="getText"></a><div class="element clickable method public getText" data-toggle="collapse" data-target=".getText .collapse">
<h2>Retrieves the language idiom for a given key</h2>
<pre>getText(\framework\library\type $key, array $args) : \framework\library\type</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\framework\library\Language::getText()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::getText()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>\framework\library\type</code><p>The name of the language idiom</p></div>
<div class="subelement argument">
<h4>$args</h4>
<code>array</code><p>An array of replacement parameters for vsprintf()</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>\framework\library\type</code>String The localized idiom</div>
</div></div>
</div>
<a name="index" id="index"></a><div class="element clickable method public index" data-toggle="collapse" data-target=".index .collapse">
<h2>index()
        </h2>
<pre>index() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="set" id="set"></a><div class="element clickable method public set" data-toggle="collapse" data-target=".set .collapse">
<h2>Convenience method for the use by controllers</h2>
<pre>set(string $key, mixed $value) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr>
<tr>
<th>see</th>
<td>\framework\engine\Registry::set()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::set()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code><p>name to provide for value</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>value to be stored in registry</p></div>
</div></div>
</div>
<a name="setElement" id="setElement"></a><div class="element clickable method public setElement" data-toggle="collapse" data-target=".setElement .collapse">
<h2>Convenience method for the use by controllers</h2>
<pre>setElement(\framework\engine\type $array_name, \framework\engine\type $data, string $keyname) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr>
<tr>
<th>see</th>
<td>\framework\engine\Registry::set()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::setElement()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$array_name</h4>
<code>\framework\engine\type</code><p>Name of the array to store the key/value pair in</p>
</div>
<div class="subelement argument">
<h4>$data</h4>
<code>\framework\engine\type</code><p>The data to be stored in the registry element with key of keyname</p></div>
<div class="subelement argument">
<h4>$keyname</h4>
<code>string</code><p>The name to give the array element that contains the new data</p></div>
</div></div>
</div>
<a name="addChild" id="addChild"></a><div class="element clickable method protected addChild" data-toggle="collapse" data-target=".addChild .collapse">
<h2>Adds a child controller to the list of controllers to execute</h2>
<pre>addChild(string $child) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Actions</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::addChild()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$child</h4>
<code>string</code>
</div>
</div></div>
</div>
<a name="addChildren" id="addChildren"></a><div class="element clickable method protected addChildren" data-toggle="collapse" data-target=".addChildren .collapse">
<h2>Adds children controllers listed in the controller method being executed</h2>
<pre>addChildren() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Actions</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::addChildren()</td>
</tr>
</table>
</div></div>
</div>
<a name="addModules" id="addModules"></a><div class="element clickable method protected addModules" data-toggle="collapse" data-target=".addModules .collapse">
<h2>Adds modules listed in the controller method being executed</h2>
<pre>addModules() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Actions</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::addModules()</td>
</tr>
</table>
</div></div>
</div>
<a name="forward" id="forward"></a><div class="element clickable method protected forward" data-toggle="collapse" data-target=".forward .collapse">
<h2>Internal forwarding to another main action without redirecting client</h2>
<pre>forward(string $route) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Replaces the requested main action with a different main action.  Usually
used when the main action failed or the site cannot repsond for some reason.</p></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Actions</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::forward()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$route</h4>
<code>string</code><p>in the form [context/]controller[/method/arg/arg/...]</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>The method parameters exposed by the actions object</div>
</div></div>
</div>
<a name="redirect" id="redirect"></a><div class="element clickable method protected redirect" data-toggle="collapse" data-target=".redirect .collapse">
<h2>Convenience method for redirecting from within controllers</h2>
<pre>redirect(string $url, int $status) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Document</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::redirect()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$url</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$status</h4>
<code>int</code>
</div>
</div></div>
</div>
<a name="render" id="render"></a><div class="element clickable method protected render" data-toggle="collapse" data-target=".render .collapse">
<h2>Recursive function is called repeatedly to construct output.</h2>
<pre>render(String $type) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>First called by the main action (ie. Home controller). Each of
the called method's children classes are then called one-by-one and each
in turn calls this method.  They may have children of their own so this
process continues until every cascaded child controller passes through
here. All modules are passed through precisely in the same manner.
Eventually, the main action will be the very last action to
render and it will call the appropriate rendering function.</p></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Document</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::render()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$type</h4>
<code>String</code><p>can be one of document, json, rss2.0 or atom</p></div>
</div></div>
</div>
<a name="setTemplate" id="setTemplate"></a><div class="element clickable method protected setTemplate" data-toggle="collapse" data-target=".setTemplate .collapse">
<h2>Allows template swapping from inside the page Controller object</h2>
<pre>setTemplate(string $name) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The only limitation is that the template being swapped out must reside
in the same directory as the primary template.  The primary template
is always named the same as the controller.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::setTemplate()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code><p>The name of the new template</p></div>
</div></div>
</div>
<a name="consolidateData" id="consolidateData"></a><div class="element clickable method private consolidateData" data-toggle="collapse" data-target=".consolidateData .collapse">
<h2>Combines all child controller and module output</h2>
<pre>consolidateData() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Data must be consolidated prior to loading the main action template
to ensure all components are collected for output.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::consolidateData()</td>
</tr></table>
</div></div>
</div>
<a name="init" id="init"></a><div class="element clickable method private init" data-toggle="collapse" data-target=".init .collapse">
<h2>Sets the base language</h2>
<pre>init() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Limits the loading of the base language to a single iteration.</p>

<p>Many controllers are instantiated during any page load. This method
ensures duplication does not occur in loading the base language file.</p></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\framework\library\Language::init()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::init()</td>
</tr>
</table>
</div></div>
</div>
<a name="isCached" id="isCached"></a><div class="element clickable method private isCached" data-toggle="collapse" data-target=".isCached .collapse">
<h2>Checks to see if a cached file should be returned, finds it and sets
output content from the cache.</h2>
<pre>isCached(boolean $isMainAction, string $type) : boolean</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>see</th>
<td>\framework\engine\Docment-&gt;render()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::isCached()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$isMainAction</h4>
<code>boolean</code><p>To call renderFinal() or not</p>
</div>
<div class="subelement argument">
<h4>$type</h4>
<code>string</code><p>of document to render</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>boolean</code>True if content was set from cache, false otherwise</div>
</div></div>
</div>
<a name="setupLogin" id="setupLogin"></a><div class="element clickable method private setupLogin" data-toggle="collapse" data-target=".setupLogin .collapse">
<h2>setupLogin()
        </h2>
<pre>setupLogin() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="setupLogout" id="setupLogout"></a><div class="element clickable method private setupLogout" data-toggle="collapse" data-target=".setupLogout .collapse">
<h2>setupLogout()
        </h2>
<pre>setupLogout() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="writeCache" id="writeCache"></a><div class="element clickable method private writeCache" data-toggle="collapse" data-target=".writeCache .collapse">
<h2>Checks to see if the buffer outut should be cached and writes it if so</h2>
<pre>writeCache(boolean $isMainAction, string $contents) : null</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::writeCache()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$isMainAction</h4>
<code>boolean</code><p>To call renderFinal() or not</p>
</div>
<div class="subelement argument">
<h4>$contents</h4>
<code>string</code><p>Contents from the output buffer to be stored</p></div>
<h3>Returns</h3>
<div class="subelement response"><code>null</code></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24action" id="$action"> </a><div class="element clickable property protected $action" data-toggle="collapse" data-target=".$action .collapse">
<h2>Makes the Actions object available to the page controllers</h2>
<pre>$action </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$action</td>
</tr></table>
</div></div>
</div>
<a name="%24config" id="$config"> </a><div class="element clickable property protected $config" data-toggle="collapse" data-target=".$config .collapse">
<h2>Makes the Config object available to the page controllers</h2>
<pre>$config </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$config</td>
</tr></table>
</div></div>
</div>
<a name="%24data" id="$data"> </a><div class="element clickable property protected $data" data-toggle="collapse" data-target=".$data .collapse">
<h2>Holds page data that will be used by the view templates</h2>
<pre>$data </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$data</td>
</tr></table>
</div></div>
</div>
<a name="%24document" id="$document"> </a><div class="element clickable property protected $document" data-toggle="collapse" data-target=".$document .collapse">
<h2>Makes the Docment object available to the page controllers</h2>
<pre>$document </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$document</td>
</tr></table>
</div></div>
</div>
<a name="%24isCachable" id="$isCachable"> </a><div class="element clickable property protected $isCachable" data-toggle="collapse" data-target=".$isCachable .collapse">
<h2>$isCachable</h2>
<pre>$isCachable </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24registry" id="$registry"> </a><div class="element clickable property protected $registry" data-toggle="collapse" data-target=".$registry .collapse">
<h2>Makes the Registry object available to the page controllers</h2>
<pre>$registry </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$registry</td>
</tr></table>
</div></div>
</div>
<a name="%24request" id="$request"> </a><div class="element clickable property protected $request" data-toggle="collapse" data-target=".$request .collapse">
<h2>Makes the Request object available to the page controllers</h2>
<pre>$request </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$request</td>
</tr></table>
</div></div>
</div>
<a name="%24url" id="$url"> </a><div class="element clickable property protected $url" data-toggle="collapse" data-target=".$url .collapse">
<h2>Makes the URL object available to the page controllers</h2>
<pre>$url </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$url</td>
</tr></table>
</div></div>
</div>
<a name="%24user" id="$user"> </a><div class="element clickable property protected $user" data-toggle="collapse" data-target=".$user .collapse">
<h2>Makes the User object available to the page controllers</h2>
<pre>$user </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$user</td>
</tr></table>
</div></div>
</div>
<a name="%24cache" id="$cache"> </a><div class="element clickable property private $cache" data-toggle="collapse" data-target=".$cache .collapse">
<h2>Holds the Cache object for use within this controller</h2>
<pre>$cache </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$cache</td>
</tr></table>
</div></div>
</div>
<a name="%24directory" id="$directory"> </a><div class="element clickable property private $directory" data-toggle="collapse" data-target=".$directory .collapse">
<h2>$directory</h2>
<pre>$directory </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\framework\library\Language::$$directory</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\framework\engine\Controller::$$directory</td>
</tr>
</table>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a7</a> and<br>
            generated on 2012-07-06T18:53:44-05:00.<br></footer></div>
</div>
</body>
</html>
